Skip to content

[READY FOR REVIEW] Add doc strings, avoid traps#21

Open
timohanke wants to merge 17 commits intodfinity:mainfrom
research-ag:doc-strings
Open

[READY FOR REVIEW] Add doc strings, avoid traps#21
timohanke wants to merge 17 commits intodfinity:mainfrom
research-ag:doc-strings

Conversation

@timohanke
Copy link
Copy Markdown
Contributor

@timohanke timohanke commented Apr 24, 2026 •
edited
Loading

  • Add doc string to all functions and public objects
  • Bugfix: Bech32.decode() falsely rejected all-numeric input

Writing the doc strings brought to light inconsistent error case behaviour. Some errors trapped, some returned #err. This was fixed:

  • Add input checks in Wif.decode(), Segwit.encode()
  • Make non-trapping:
    • Base58Check.decode()
    • Address.addressFromText()
    • P2pkh.decodeAddress()
    • P2pkh.decodeAddress()
    • P2pkh.makeScript()
    • Address.scriptPubKey()
    • Bitcoin.buildTransaction()
    • Wif.decode()

timohanke and others added 17 commits April 23, 2026 11:08
@timohanke
Add doc strings by Opus 4.7
0db2124
@AndyGura
Improve error handling and clarify documentation across various modules.
18cdbc9
@AndyGura
Clarify documentation for SegWit address encoding and update example …
e5b350b 
…in decode function.
@timohanke
Add argument checks in Segwit.encode() suggested by CodeRabbit
5db572d 
witness version <= 16
program length in [2,40]
program length 20 or 32 for version 0
@timohanke
Add check in Wif.decode for invalid scalars (by CodeRabbit)
38f69e0 
Include unit tests for invalid scalars
@timohanke
Fix comment about field prime (by CodeRabbit)
3e1c8de
@timohanke
Add tests for Bech32.decode that currently fail, exposing a bug
afbed9c 
The test vectors consist exclusively of numerical characters
@timohanke
Make Bech32.decode accept an all-numeric character string
fdbda5b
@timohanke
Avoid trap in Base58Check.decode on too short input
d82c7a9
@timohanke
Add failing test which should succeed according to doc string
cbdc26d
@timohanke
Make test pass again by avoiding internal traps
07c4ee8
@timohanke
Make bitcoin/Wif.decode non-trapping
72b6482
@timohanke
Fix small CodeRabbit comments
3c473e5
@timohanke
Update CHANGELOG
0b75426
@timohanke
Fixes in response to a fresh round of CodeRabbit comments
58f5bdc
@timohanke
Run prettier formatter
6ceba99
@timohanke
Bump core dependency
cc14754
@timohanke timohanke requested a review from a team as a code owner April 24, 2026 20:10
@timohanke timohanke changed the title Add doc strings, avoid traps [READY FOR REVIEW] Add doc strings, avoid traps Apr 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

external-contributor

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@timohanke @AndyGura